Skip to main content
GET
/
tools
/
openapi
/
{tool_id}
Get OpenAPI Tool Info by ID
curl --request GET \
  --url https://agent-prod.studio.lyzr.ai/v3/tools/openapi/{tool_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "tool123",
  "name": "Sample OpenAPI Tool",
  "openapi_schema": {},
  "paths": {}
}

​
Endpoint

GET /v3/tools/openapi/{tool_id}

​
Description

Fetches detailed information about a specific OpenAPI tool.

​
Authentication

API Key (x-api-key) in the header.

​
Request Parameters

ParameterTypeDescription
tool_idStringThe ID of the tool to retrieve.

​
Curl Request

curl -X GET "https://agent-prod.studio.lyzr.ai/v3/tools/openapi/{tool_id}" ^
-H "accept: application/json" ^
-H "x-api-key: sk-default-REDACTED"

​
Response

Returns detailed information about the specified OpenAPI tool, including paths and methods.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
tool_id
string
required

The ID of the tool to retrieve.

Response

OpenAPI tool info retrieved successfully

​
id
string
Example:

"tool123"

​
name
string
Example:

"Sample OpenAPI Tool"

​
openapi_schema
object

The OpenAPI schema defining the tool

​
paths
object

Paths and operations available in the tool